detox-allure2-adapter

Important

Breaking Change in v1.0.0-alpha.35: This version introduces a major architectural change where the adapter replaces Detox's built-in artifacts manager. This means Detox's native screenshot, video, and UI hierarchy collection is disabled, and the adapter now handles all artifact collection. If you're upgrading from an earlier version, you may need to adjust your configuration and test expectations.

Prerequisites

To use Detox, Jest, and Allure together, please verify that the following modules are part of your devDependencies in your package.json file.

"devDependencies": {
  "detox": "^20.42.0",
  "detox-allure2-adapter": "^1.0.0-alpha.37",
  "jest": "^30.2.0",
  "jest-allure2-reporter": "^2.2.8",
  "jest-metadata": "^1.6.0"
}

If not, add the necessary modules and run npm install.

Setting Up detox.config.js

Find .detoxrc.json, detox.config.js or where your Detox configuration is stored. Add "extends" to include this adapter's preset:

{
  "extends": "detox-allure2-adapter/preset-detox"
}

Setting Up jest.config.js

A configuration file for Jest named jest.config.js needs to be present. Add or update the following sections:

module.exports = {
    // ...
    reporters: [
      'detox/runners/jest/reporter',
      ['jest-allure2-reporter', {
        extends: 'detox-allure2-adapter/preset-allure',
        /* see https://github.com/wix-incubator/jest-allure2-reporter/blob/beta/index.d.ts */
      }],
    ],
    // ...
    testEnvironmentOptions: {
      eventListeners: [
        'jest-metadata/environment-listener',
        'jest-allure2-reporter/environment-listener',
        ['detox-allure2-adapter', {
          deviceLogs: true,
          deviceScreenshots: true,
          deviceVideos: true,
          deviceViewHierarchy: true,
        }],
      ],
    },
    // ...
}

Here's a brief explanation of what you just added:

• reporters section: We added Detox and the Allure2 reporter. The latter will enable us to generate Allure reports based on our Jest tests run with Detox.

• testEnvironmentOptions section: We added three event listener modules that will run during our tests — jest-metadata, jest-allure2-reporter, and detox-allure2-adapter. These listeners will collect necessary metadata and feed test result data to our Allure reports.

Important Notes

Artifacts Management

This adapter replaces Detox's built-in artifacts manager with its own implementation to provide better integration with Allure reporting. This means:

• All Detox's native artifacts (except detox.log) are disabled in favor of the adapter's implementation
• User artifacts (like device.takeScreenshot()) are automatically integrated with Allure when userArtifacts is not set to 'ignore'
• All artifacts are stored in the artifacts/ directory by default

Adapter Options

userArtifacts: 'ignore' | 'copy' | 'move'

Controls how user artifacts (like device.takeScreenshot(), device.captureViewHierarchy(), etc.) are handled by the adapter.

Configuration:

• 'move' (default): Copy user artifacts to the Allure attachments directory and delete the temporary file after the test suite completes. This imitates Detox's default behavior.
• 'copy': Copy user artifacts to the Allure attachments directory and keep the original file intact.
• 'ignore': Disable automatic handling of user artifacts. You'll need to manually attach them to Allure reports.

Note: When userArtifacts is set to 'copy' or 'move', the adapter automatically wraps device methods like takeScreenshot() and captureViewHierarchy() to integrate them with Allure reporting.

deviceLogs: boolean | DetoxAllure2AdapterDeviceLogsOptions

Enables capturing device (iOS/Android) logs for each step. This feature uses the logkitten library.

Configuration:

• true (default): Enables log capture with default settings.

• false: Disables log capture.

• DetoxAllure2AdapterDeviceLogsOptions (object): Enables log capture and provides fine-grained control over the settings.

  • ios: (entry: IosEntry) => boolean: Filter function for iOS logs. Return true to include the log entry.
  • android: (entry: AndroidEntry) => boolean: Filter function for Android logs. Return true to include the log entry.
  • override: boolean: Whether to override existing log handlers.
  • saveAll: boolean (default: false): If true, saves logs for all steps. By default, only logs for failed steps are kept.
  • syncDelay: number | { ios?: number; android?: number } (default: 500): Synchronization delay in milliseconds for log collection. Set to 0 to disable, or provide per-platform delays.

deviceScreenshots: boolean | DetoxAllure2AdapterDeviceScreenshotOptions

Enables taking screenshots for each step. This feature uses the screenkitten library.

Configuration:

• true (default): Enables screenshot capture with default settings.

• false: Disables screenshot capture.

• DetoxAllure2AdapterDeviceScreenshotOptions (object): Enables screenshot capture and provides fine-grained control over the settings.

  • saveAll: boolean (default: false): If true, saves screenshots for all steps. By default, only screenshots for failed steps are kept.

deviceVideos: boolean | DetoxAllure2AdapterDeviceVideoOptions

Enables "on-demand" video recording for your tests. This feature uses the videokitten library. The recording starts automatically upon the first interaction with the device and stops when the test is complete.

Configuration:

• true (default): Enables video recording with default settings.

• false: Disables video recording.

• DetoxAllure2AdapterDeviceVideoOptions (object): Enables recording and provides fine-grained control over the settings.

  • saveAll: boolean (default: false): If true, saves videos for all tests. By default, only videos for failed tests are kept.
  • ios: Partial<VideokittenOptionsIOS>: Custom options for iOS, as defined by videokitten.
  • android: Partial<VideokittenOptionsAndroid>: Custom options for Android, as defined by videokitten.

Refer to the videokitten documentation for a full list of options for each platform.

deviceViewHierarchy: boolean | DetoxAllure2AdapterDeviceViewHierarchyOptions

Enables capturing and visualizing the device's view hierarchy for test failures. This feature creates interactive HTML visualizations of the UI structure at the time of failure.

Configuration:

• true (default): Enables view hierarchy capture with default settings.

• false: Disables view hierarchy capture.

• DetoxAllure2AdapterDeviceViewHierarchyOptions (object): Enables capture and provides fine-grained control over the settings.

  • stylesheet?: string | null | false: Path or content for a custom XSL stylesheet to control view hierarchy visualization.
    • If you provide a URL, it will be used as an external stylesheet.
    • If you provide a string starting with <?xml, it will be embedded directly as a data URI.
    • If false, null, or empty string, no stylesheet is applied (raw XML output).
    • If undefined, the default stylesheet is used.
    • Note: Some browsers (like Safari) may block embedded stylesheets for security reasons. For best compatibility, host your stylesheet on the same domain as your Allure reports.

Tip

The default XSL template is available for reference and modification at:

• node_modules/detox-allure2-adapter/view-hierarchy.xsl

Download and modify this file as needed, then host it and provide its URL to use your custom visualization.

Example with custom options:

// jest.config.js
module.exports = {
  eventListeners: [
    'jest-metadata/environment-listener',
    'jest-allure2-reporter/environment-listener',
    ['detox-allure2-adapter', {
      userArtifacts: 'move',
      deviceLogs: {
        saveAll: true,
        ios: (entry) => entry.level === 'error',
        android: (entry) => entry.priority === 'E',
      },
      deviceScreenshots: {
        saveAll: true,
      },
      deviceVideos: {
        saveAll: true,
        ios: {
          codec: 'hevc',
        },
        android: {
          bitRate: 4_000_000,
        }
      },
      deviceViewHierarchy: {
        // external URL
        stylesheet: 'https://my-allure-reports-domain.com/path/to/view-hierarchy.xsl',
        // or inline stylesheet (data URI)
        // stylesheet: '<?xml version="1.0" encoding="utf-8"?><xsl:stylesheet...',
        // or disable stylesheet (raw XML output)
        // stylesheet: false,
      }
    }],
  ],
},

Running Tests

After making these changes, you can run your tests as usual. The tests will run with Detox and Jest, and the results will be reported using Allure. Configure your npm test script in the package.json file to run your Detox tests.

Depending on how jest-allure2-reporter is configured, you should be able to see the Allure reports in the output directory artifacts (or allure-results, or the one that is specified by you). You will need the Allure command line tool to generate a report in a browser viewable format. The report data is present but needs Allure to view it in a human-readable format.