Documentation

Overview

TestHub stores and serves Allure 3 test reports published from CI pipelines or local execution. Reports are published using Allure 3 native publishing — set publish: true in your allure config and run npx allure generate. Allure CLI handles everything automatically. Static assets (~1.5 MB) are stored once per Allure version; each run uploads only dynamic data (~10-50 KB) — saving ~98% storage.

Quick Start

1. Get an ars1 token from your TestHub admin (generated via POST /api/token)
2. Add allurerc.mjs to your project root:

// allurerc.mjs
import { defineConfig } from "allure";

export default defineConfig({
  name: "My Project",
  plugins: {
    awesome: { options: { publish: true } },
  },
  allureService: {
    accessToken: process.env.TESTHUB_TOKEN,
  },
});

3. Store your token as TESTHUB_TOKEN in CI secrets (or env var locally)
4. Publish: npx allure@^3 generate allure-results

The report URL is printed in the console. Reports appear in the dashboard automatically.

CI Examples

stage('Publish Report') {
  steps {
    withCredentials([string(
      credentialsId: 'testhub-token',
      variable: 'TESTHUB_TOKEN')]) {
      bat 'npx allure@^3 generate build/allure-results'
    }
  }
}

- name: Publish Allure report
  if: always()
  env:
    TESTHUB_TOKEN: ${{ secrets.TESTHUB_TOKEN }}
  run: npx allure@^3 generate allure-results

How It Works

When you run npx allure generate with publish: true, Allure CLI automatically:

1. Creates a draft report on TestHub
2. Uploads shared static assets (JS/CSS/fonts) — skipped if already uploaded for this Allure version
3. Uploads report-specific data (index.html, test results, widgets)
4. Completes the report with statistics and history

The ars1 token is self-describing — it contains the server URL. No separate URL configuration needed.

Authentication

Dashboard access is protected by Cloudflare Access. Sign in with your email to view the dashboard and reports.

Report publishing uses ars1 tokens. Your admin generates these via the POST /api/token endpoint. Store the token as TESTHUB_TOKEN in your CI secrets. The token embeds the server URL — no additional configuration needed.

Dashboard API tokens (from API Keys) are for querying runs, apps, and history from scripts. They are not used for publishing reports.

Roles & Permissions

TestHub has four roles with configurable permissions:

Admins can customize per role in Settings → Role Permissions.

Troubleshooting

Open interactive API docs (Swagger) →