allure-rstest#

Allure Report integration for the rstest test runner.

Not battle tested. Almost fully vibe-coded, but design is inspired by allure-vitest and DX improved according to hands on experience of allure-jest and allure-vitest.

Installation#

npm install --save-dev allure-rstest

Configuration#

Both lines are required. rstest does not let a reporter append setupFiles for you, so the setup file is wired up manually.

// rstest.config.ts
import { defineConfig } from '@rstest/core';
import AllureRstestReporter from 'allure-rstest/reporter';

export default defineConfig({
  setupFiles: ['allure-rstest/setup'],
  reporters: [
    'default',
    new AllureRstestReporter({ resultsDir: './allure-results' }),
  ],
});

Metadata#

Four channels work at the same time and are merged as described below.

Declarative (recommended)#

rstest inherits meta from describe down to nested tests, and child keys override inherited ones — the runner does this for you. Use allureMeta() (instead of a raw object) so the Allure keys are type-checked at compile time.

import { describe, test } from '@rstest/core';
import { allureMeta } from 'allure-rstest';

describe('Billing', { meta: allureMeta({ epic: 'Payments' }) }, () => {
  test('charges a card', {
    meta: allureMeta({
      feature: 'Checkout',
      severity: 'critical',
      owner: 'team-payments',
      tags: ['smoke'],
      labels: { component: 'billing-api' },
      links: { issue: 'AE-123' },
    }),
  }, async () => {
    // ...
  });
});

Runtime API#

import { Allure, attachment, component, feature, step } from 'allure-rstest';

test('charges a card', async () => {
  await feature('Checkout');
  await component('billing-api');
  await Allure.severity('critical');

  await step('create the order', async (ctx) => {
    await ctx.parameter('currency', 'EUR');
  });

  await attachment('payload', JSON.stringify(body), 'application/json');
});

A synchronous variant is available from allure-rstest/sync; the same names return void.

In the test title#

test('charges a card @allure.id:42 @allure.label.feature:Checkout', fn);
test('refunds @allure.link.issue:https://example.org/AE-123', fn);

Application order#

Title → declarative meta (suite, then test) → runtime API.

• Multiple-valued labels (epic, feature, story, component, layer, tag, arbitrary ones) accumulate across all channels.
• Single-valued labels (severity, owner, lead, allureId, parentSuite, suite, subSuite) — the last channel wins.
• Links and parameters accumulate.

Technical labels (host, thread, package, framework, language) are set by the reporter and are not overridden by user channels.

Arbitrary labels#

component is not part of Allure's built-in label set and does not feed the Behaviors tab — it is a plain label used for grouping and filtering.

import { component, customLabel } from 'allure-rstest';

const squad = customLabel('squad');

await component('billing-api');
await squad('alpha');

Reporter configuration#

Disabling#

To run rstest with zero Allure side effects (for example, in fast local development while keeping the report only on CI), either set the env var for the whole run:

ALLURE_ENABLED=false npm test

or pass enabled: false to the reporter:

new AllureRstestReporter({ enabled: false }),

When disabled, the setup file skips wrapping test/it, matchers and the runtime, and the reporter writes nothing. The deprecated globalThis.allure object stays defined as a no-op, so existing code using it keeps working.

Browser mode#

setupFiles: ['allure-rstest/browser/setup'],

Limitations#

• Testplan does not work in browser mode. rstest has neither browser.commands nor provide/inject, so there is no way to read the testplan file from the browser.
• Per-test metadata is not captured in browser mode (v1). Browsers have no AsyncLocalStorage, so the running test cannot be resolved and Allure API calls inside a browser test are no-ops. Browser mode runs the tests and produces results, but steps, attachments and labels are not reported per test.
• The integration relies on an internal rstest detail (globalThis["@rstest/core"]) and is verified against @rstest/core@0.11.12. On a minor version mismatch the package prints a warning.

Contribution#

Welcome.

License#

MIT