Skip to main content

Bruno

Installation​

Install the npm package:

npm install @orangebeard-io/bruno-reporter

The source code can be found on GitHub: Bruno Orangebeard Reporter

Configuration​

Create orangebeard.json in your Bruno collection's folder (or above):

{
  "endpoint": "https://app.orangebeard.io/{ORGANIZATION}",
  "token": "{ACCESS_TOKEN}",
  "project": "{ORANGEBEARD_PROJECT}",
  "testset": "My Test Set Name",
  "description": "Optional description",
  "attributes": [
    {
      "key": "Tool",
      "value": "Bruno"
    }
  ]
}

Note: Description and attributes are optional.

Running​

1. Generate a JSON report with Bruno CLI​

Run your Bruno collection with the JSON reporter:

bru run --reporter-json results.json

2. Report the JSON results to Orangebeard​

bruno-to-orangebeard -f results.json

Or using npm run:

npm run report -- -f results.json

What gets reported​

  • The suite structure and test names are derived from each result's test.filename (e.g. Basic/ChuckNorris/ChuckNorris Facts.bru → Suite: Basic / ChuckNorris, Test: ChuckNorris Facts).
  • Request and response metadata is logged in Markdown, including headers and bodies.
  • Bruno assertion results and test results are mapped to Orangebeard steps. Failed steps include the error message as an error log.
  • Top-level errors (e.g. missing modules, network failures) are reported as error logs on the test.
  • When multiple iterations are present, test names are suffixed with the iteration index.