Katalon has no first-party Allure adapter, so I maintain two open source bridges that add one. The Allure 3 version is out now and I wanted to share it here, along with one gotcha that will bite anyone moving from Allure 2.
Install
Needs Node.js 18 or newer.
npx allure3-katalon-bridge install "/path/to/your/katalon/project"
There are also double-click installers under Windows/, macOS/ and Linux/ if you would rather not use a terminal.
It copies a Test Listener, some Keywords, config and two jars into the project. Katalon auto-discovers the listener, so nothing else is wired up. No plugin, no OSGi packaging, and no changes to your existing Test Cases or Test Suites. Re-running it upgrades in place, and uninstall removes exactly what it installed.
What you get
Run any Test Suite or Test Suite Collection as normal. Afterwards you get one self-contained .html in allure-report/ that you open by double clicking. No server, no separate allure generate step.
A Test Suite Collection produces one combined report named after the collection, not one report per member suite.
You also get failure screenshots for WebUI tests, Katalon log lines as nested Allure steps, browsers as first-class Allure environments, and trend and retry history that carries forward between runs.
There is no global Allure install. The Allure 3 CLI is a Node program, so it ships pinned inside the package and its exact path is recorded at install time. If you ever fought with Katalon Studio not finding allure on PATH when launched from the Start Menu or Dock, that class of problem is gone.
The gotcha if you are coming from Allure 2
Allure 3 reads Allure 2 results natively, so it is tempting to point allure 3.x at an existing Allure 2 bridge’s output. Do not. You get a report that looks fine and is not.
Allure 3 ignores the historyId a result declares and recomputes its own, then groups retries and shows only the newest attempt in each group. Katalon reuses one test case across many suites under a single testCaseId. Put those together and separate runs of the same test case look like retries of each other.
On a real six result run with one genuine failure, that showed two tests and reported the build as passed. The failing run was hidden behind a later passing one.
This bridge writes a Suite parameter, a browser label and a Browser parameter so each execution keeps its own identity, in the report body and in history. Same run, same results: six tests, reported failed.
CI
Verified on Azure Pipelines hosted agents for Windows, macOS and Ubuntu. Ready-to-copy configs are in the repo for Azure Pipelines, GitHub Actions and GitLab CI.
Two things Linux needs that the other two do not, both included in the example config: Xvfb, because Katalon Studio is an Eclipse application and wants a display even when the browser runs headless, and JDK 21, because Katalon 11.x’s OSGi bundles require it and the Ubuntu image does not default to it.
Links
- GitHub: GitHub - montbaga/allure3-katalon-bridge: Zero-touch Allure 3 reporting for Katalon Studio projects : Install with one command, no plugin, no OSGi packaging, no global Allure install · GitHub
- npm: https://www.npmjs.com/package/allure3-katalon-bridge
- Allure 2 version, still maintained: GitHub - montbaga/allure-katalon-bridge: Zero-touch Allure reporting for Katalon Studio : No plugin, No OSGi packaging, No test script changes. · GitHub
Apache 2.0. Tested against Katalon Studio 11.3 and 11.4.
Happy to answer questions here, and issues or feature requests are welcome on the repo. If you try it on a Katalon version or CI setup I have not covered, I would like to hear how it goes
