@cucumber/query

What is @cucumber/query?

@cucumber/query is a JavaScript library that provides a query interface for Cucumber's test results. It allows users to filter and retrieve information about test runs, scenarios, steps, and their outcomes. This package is particularly useful for analyzing and reporting on Cucumber test results programmatically.

What are @cucumber/query's main functionalities?

Querying Test Results

This feature allows users to query and filter test results based on various criteria, such as status, tags, or names. The code sample demonstrates how to retrieve all scenarios that have passed.

const { Query } = require('@cucumber/query');
const query = new Query();

// Example: Retrieve all scenarios with a specific status
const scenarios = query.getScenarios().filter(scenario => scenario.status === 'passed');

Aggregating Test Data

Users can aggregate test data to get insights, such as counting the number of failed steps. This feature is useful for generating summaries and reports of test outcomes.

const { Query } = require('@cucumber/query');
const query = new Query();

// Example: Count the number of failed steps
const failedStepsCount = query.getSteps().filter(step => step.status === 'failed').length;

Accessing Detailed Test Information

This feature provides access to detailed information about specific test scenarios, steps, and their execution details. It is useful for debugging and understanding test failures.

const { Query } = require('@cucumber/query');
const query = new Query();

// Example: Get detailed information about a specific scenario
const scenarioId = 'some-scenario-id';
const scenarioDetails = query.getScenarioById(scenarioId);

Other packages similar to @cucumber/query

cucumber-html-reporter

cucumber-html-reporter is a package that generates HTML reports from Cucumber JSON output. While it focuses on creating visual reports, @cucumber/query provides a programmatic interface for querying test results, making it more suitable for custom data processing and analysis.

cucumber-junit

cucumber-junit is a package that converts Cucumber JSON reports into JUnit XML format. It is primarily used for integrating with CI/CD tools that require JUnit format. In contrast, @cucumber/query is used for querying and analyzing test results directly within JavaScript applications.

cucumber-pretty

cucumber-pretty is a package that formats Cucumber output to be more human-readable. While it enhances the readability of test results, @cucumber/query provides a more flexible and detailed approach to accessing and manipulating test data programmatically.

README

The README file is missing

Changelog

[13.1.0] - 2025-01-14

Added

• New method findAttachmentsBy(TestStepFinished) (#67)
• New method findHookBy(TestStep) (#67)
• New method findMeta() (#67)

Fixed

• [JavaScript] Attachments are not presumed to have a related test step (#67)