DOCSEARCHbyAlgolia
Submit Docs

TestBeats Documentation

website·Indexed 31 days ago

https://docs.testbeats.com

A platform for delivering test results to various targets such as Slack, Microsoft Teams, Google Chat, and GitHub. It features a CLI for publishing results, integrations for frameworks like Playwright, PyTest, WebdriverIO, CucumberJS, and JUnit XML, and extensions for AI failure summaries, ReportPortal, and Percy analysis. It also includes a beta for manual test management using Gherkin feature files.

Tokens
28.4K
Snippets
147
Records
218
Agent score
57%

What's inside TestBeats

  1. Overview of the CI Info Extension

    The ci-info extension attaches CI/CD pipeline details—such as repository name, build links, branch names, and pull request information—to notifications. It is compatible with GitHub Actions, Azure Pipelines, and GitLab CI. By default, it triggers on the after-summary hook and uses the passOrFail condition.

  2. Overview of TestBeats Extensions

    Extensions are modular components in TestBeats used to enrich notification targets (such as Slack or Teams) with additional data, formatting, and functionality. They process test data to extract relevant information, add context and metadata, and modify how reports are presented to the end user.

  3. Overview of TestBeats unified test reporting

    TestBeats is a unified test reporting and test management tool designed to centralize test results from various automation testing frameworks. It solves the problem of scattered results in CI/CD logs by providing a centralized portal and publishing summaries to communication platforms like Slack, Microsoft Teams, and Google Chat. Key features include AI-powered reporting for failure summaries and categorization, and unlimited test alerts.

  4. Overview of available TestBeats targets

    Targets are the platforms where TestBeats delivers test results. They are categorized into three types:

    • Communication Platforms: Slack, Microsoft Teams, Google Chat (all via Webhook URL), and GitHub (via GitHub Token).
    • Data and Integration Targets: InfluxDB (connection details) and HTTP (custom endpoints with URL/headers).
    • Utility Targets: GitHub Output (for GitHub Actions), Custom webhooks, and Delay (to add time between targets).

  5. Overview of Pulses for scheduled AI test reports

    Pulses allow you to schedule AI-generated test reports to be delivered to integrations (such as Slack, Teams, or Google Chat) on a recurring basis. Unlike AI Studio, which is for ad-hoc conversational Q&A within the Portal, Pulses are designed for recurring team updates delivered externally. Unlike CLI targets, which push results per-run via testbeats publish, Pulses analyze Portal history on a schedule.

  6. Overview of the GitHub Target

    The GitHub target automatically posts test summaries to GitHub pull request comments. It supports both functional and performance test results with rich formatting and can either create new comments or update existing ones based on the configuration.

  8. Understand and use AI Failure Signature for test grouping

    AI Failure Signature uses artificial intelligence to semantically analyze test case failures, grouping them based on underlying meaning and context. Unlike traditional error clustering that relies on exact string matching, this feature identifies failures that share the same root cause even if the error messages differ. It achieves this by analyzing error messages, stack traces, and failure patterns to recognize semantic similarities and recurring patterns across a test suite.

  9. JUnit XML compatibility and prerequisites for TestBeats

    TestBeats supports the standardized JUnit XML format, which is compatible with most major testing frameworks including Java (JUnit, TestNG, Selenium), JavaScript (Cypress, Playwright, WebdriverIO, Jest), Python (PyTest, unittest), C# (NUnit, MSTest), and Ruby (RSpec, Minitest).

    Prerequisites for integration:

    • Test results generated in JUnit XML format.
    • TestBeats installed (verify via npx testbeats@latest --version).
    • A webhook URL for Slack, Microsoft Teams, or Google Chat.
    • (Optional) A TestBeats API key from app.testbeats.com.

  10. Use TestBeats AI Studio for exploratory test analysis

    TestBeats AI Studio provides a ChatGPT-like interface that allows users to understand and act on automation test results using natural language. It is primarily used for ad-hoc questions and exploratory analysis within the Portal. Currently, it supports building insights by analyzing test data based on user descriptions.

  11. Generate AI failure summaries for test reports

    TestBeats automatically generates succinct summaries of test failures detected during the testing process. These summaries extract relevant information, such as error messages and impacted functionalities, and are included in the TestBeats portal report and integrated notifications (e.g., Slack) when a test run contains failures.

  12. Add a radial gauge test summary using the QuickChart extension

    The quick-chart-test-summary extension attaches a radial gauge representing the total pass percentage of a test suite using QuickChart. It triggers on the after-summary hook under the passOrFail condition. Note that this extension is not supported for Google Chat targets.