How to add custom filter

[spells39]

How can I add a custom filter to an allure report, for example, a filter based on whether a test has a bug attached?

[delatrie]

Hi, @spells39!

This feature exists in Allure 3. To use it, set the filter property of the Allure Awesome plugin config:

import { defineConfig } from "allure";

export default defineConfig({
  output: "./out/allure-report",
  plugins: {
    awesome: {
      options: {
        filter: ({ links }) => links.some(({ type }) => type === "issue"),
      },
    },
  },
});

By default, Allure 3 loads the configuration from allurerc.mjs in the current working directory. Use --config to provide a custom path: allure --config ./my-config.mjs generate ./allure-results.

[spells39]

This way I can filter tests with attached bugs?

[delatrie]

It depends on your definition of "tests with attached bugs." The example above will only keep tests with links to issues. If that's what you need, it should work.

[spells39]

This is not quite what I need. With the config you suggested, only tests with attached bugs are included in the report. Is it possible to add a custom filter for attached bugs to the report, but still include all tests?

[delatrie]

I see, I've misunderstood your question.
Unfortunately, there is neither a ready-to-use filter that suits your needs nor a mechanism to introduce a custom one. You may open a feature request here if you wish.

The best workaround I can think of is tagging tests you'd like to keep and then filtering them by the tag in the report.

Here is an example with Playwright:

import { test } from "@playwright/test";
import { tag, issue } from "allure-js-commons";

const assignIssue = async (url) => {
  await tag("issue"); // Use the Allure API to tag the test result
  await issue(URL); // Use the Allure API to add an issue link to the test result
};

test("A test with an issue", async () => {
  // Use a custom function to tag and link to an issue at once
  await assignIssue("https://github.com/orgs/allure-framework/discussions/3008");
});

test("A test with no issue", async () => {});

Currently, this only works in Allure 2. Filtering by tags is in our backlog for Allure 3 and will be implemented in the future.