Creating custom CTRF attestation type

In this tutorial, we will create a custom attestation type with schema and evaluation for Common Test Report Format

In this tutorial, we will create a custom attestation type for CTRF. By the end, you will have a reusable ctrf attestation type in Kosli that validates test reports and enforces a zero-failures compliance rule.

Prerequisites

• Install Kosli CLI.
• Get a Kosli API token.
• A Kosli flow and trail to attest to — follow the Getting started guide if you need one.

Download the CTRF schema

Download the official JSON schema for CTRF to a file named ctrf-schema.json:

curl -o ctrf-schema.json https://ctrf.io/schemas/schema.json

Create the attestation type

Use kosli create attestation-type to define the new type with a jq compliance rule that requires zero failed tests:

kosli create attestation-type ctrf \
  --description "Attestation for Common Test Report Format (CTRF)" \
  --schema ctrf-schema.json \
  --jq '.results.summary.failed == 0'

You should see: attestation-type ctrf was created.

You can verify it exists by running:

kosli get attestation-type ctrf

Report a CTRF attestation

Once your tests have run and produced a CTRF report (e.g. ctrf-report.json), report it to Kosli:

kosli attest custom \
  --type ctrf \
  --name playwright-tests \
  --flow <your-flow-name> \
  --trail <your-trail-name> \
  --attestation-data ctrf-report.json

Kosli will validate ctrf-report.json against the schema and evaluate the jq rule. If .results.summary.failed is 0, the attestation will be marked as compliant.

What you’ve accomplished

You have created a reusable ctrf custom attestation type and used it to report a test result to Kosli. Any team in your organization can now use this same type to uniformly enforce a zero-failures quality gate across all projects, regardless of which testing framework they use.

From here you can:

• Read the kosli create attestation-type reference for all available options
• Read the kosli attest custom reference for attesting to artifacts
• Review naming conventions for attestation types