CTRF

The Buildnote CLI collects Common Test Report Format (CTRF) test results and sends them to Buildnote. CTRF is a test report specification that gives test results the same structure across all tools and frameworks.

Configuration

To collect CTRF test results, add this section to your buildnote.json config file:

{
  "collect": {
    ...
    "ctrf": {
      "enabled": true,
      "include": [
        "**/*ctrf.json"
      ]
    }
    ...
  }
}

Metadata

To attach your own metadata to CTRF test results, add a metadata section:

{
  "collect": {
    ...
    "ctrf": {
      "enabled": true,
      "include": [
        "**/*ctrf.json"
      ],
      "metadata": {
        "test-user": "{{ env.USER }}",
        "build-environment": "{{ env.BUILD_ENV }}"
      }
    }
    ...
  }
}

Excluding paths

To leave some paths out of collection, list their globs under exclude:

{
  "collect": {
    ...
    "ctrf": {
      "exclude": [
        "**/*excluded.json",
        "/any/excluded/glob/**/"
      ]
    }
    ...
  }
}