@orangebeard-io/bruno-reporter
v1.0.1
Published
Report Bruno CLI JSON test results to Orangebeard
Readme
Installation
Install the npm package
npm install @orangebeard-io/bruno-reporterConfiguration
Create orangebeard.json in your Bruno collection's folder (or above):
{
"endpoint": "https://app.orangebeard.io/organization",
"accessToken": "00000000-0000-0000-0000-00000000", // prefer to store it in environment
"project": "my_project_name",
"testset": "My Test Set Name",
"description": "Optional description",
"attributes": [
{
"key": "Tool",
"value": "Bruno"
}
]
}Running
1. Generate a JSON report with Bruno CLI
Run your Bruno collection with the JSON reporter:
bru run --reporter-json results.json2. Report the JSON results to Orangebeard
bruno-to-orangebeard -f results.jsonOr using npm run:
npm run report -- -f results.jsonWhat gets reported
The reporter will:
- Create an Orangebeard test run from the Bruno JSON results.
- Derive the suite structure and test names from each result's
test.filename(e.g.Basic/ChuckNorris/ChuckNorris Facts.bru→ Suite:Basic/ChuckNorris, Test:ChuckNorris Facts). - Log request and response metadata in Markdown, including headers and JSON/XML/text bodies in fenced code blocks.
- Map Bruno assertion results and test results to Orangebeard steps. Failed steps include the error message as an error log.
- Report top-level errors (e.g. missing modules, network failures) as error logs on the test.
- Support multiple iterations: when more than one iteration is present, test names are suffixed with the iteration number.
