Qase.Csharp.Commons 1.1.27

Qase C# Commons

This module is an SDK for developing test reporters for Qase TestOps. It uses Qase.ApiClient.V1 and Qase.ApiClient.V2 as API clients.

Used By

To report results from tests using a popular framework, use one of these reporters instead:

• Qase.xUnit.Reporter - xUnit test framework integration
• Qase.NUnit.Reporter - NUnit test framework integration
• Qase.MSTest.Reporter - MSTest test framework integration

You should only use this package directly if you're developing a custom reporter for a specialized test framework.

Configuration

Qase C# Reporters can be configured in multiple ways:

• using a config file qase.config.json
• using environment variables

All configuration options are listed in the table below:

Running from a test plan

Setting testops.plan.id creates the test run from an existing test plan, so the run is scoped to that plan's cases instead of being a standalone run. The plan is resolved by Qase when the run is created — the reporter still submits results for whichever tests the framework actually executes.

The option is ignored when testops.run.id is set: an existing run is reused as is, and no new run is created for the plan to apply to.

Retries and timeouts

Uploading test results is the one call worth retrying, and it is safe to retry because every result carries an id that Qase uses to deduplicate a batch it has already accepted.

A results upload is retried on a transport failure and on HTTP 408, 429 and 5xx, with an exponential backoff of retryBackoff × 2^(attempt-1). It is not retried on 400, 401, 403, 404, 413, 422 or 507 — those fail identically on a second attempt. When a 429 carries a Retry-After header, that value is used instead of the computed backoff; Qase sends roughly 60 seconds, which a short backoff ladder would not survive. timeout applies to each attempt, not to the chain as a whole.

Creating and completing a test run is not retried: those calls carry no idempotency key, so a replay could create a second run. They still honour timeout.

If a batch cannot be uploaded even after the retries, the reporter logs an error naming how many results were lost and leaves the test run open. A completed run over partial data looks trustworthy and is not.

Example qase.config.json config

{
  "mode": "testops",
  "fallback": "report",
  "debug": false,
  "environment": "local",
  "logging": {
    "console": true,
    "file": false
  },
  "report": {
    "driver": "local",
    "connection": {
      "local": {
        "path": "./build/qase-report",
        "format": "json"
      }
    }
  },
  "testops": {
    "api": {
      "token": "<token>",
      "host": "qase.io",
      "timeout": 30,
      "retries": 3,
      "retryBackoff": 1
    },
    "run": {
      "title": "Regress run",
      "description": "Regress run description",
      "complete": true,
      "tags": ["tag1", "tag2"],
      "externalLink": {
        "type": "JiraCloud",
        "link": "PROJ-1234"
      }
    },
    "plan": {
      "id": 123
    },
    "defect": false,
    "showPublicReportLink": false,
    "project": "<project_code>",
    "batch": {
      "size": 100
    },
    "configurations": {
      "values": [
        {
          "name": "Browser",
          "value": "Chrome"
        },
        {
          "name": "Environment",
          "value": "Production"
        }
      ],
      "createIfNotExists": true
    },
    "statusFilter": ["passed", "failed"]
  },
  "statusMapping": {
    "invalid": "failed",
    "skipped": "passed"
  }
}

Logging Configuration

Control logging output with the logging option:

Disable console output (only log to file):

{
  "debug": true,
  "logging": {
    "console": false
  }
}

Disable all logging:

{
  "logging": {
    "console": false,
    "file": false
  }
}

Environment variables:

• QASE_LOGGING_CONSOLE - enable/disable console output (default: true)
• QASE_LOGGING_FILE - enable/disable file output (default: false, true when debug=true)

Note: Log level is controlled by the debug parameter:

• debug: true - Debug level (detailed logs)
• debug: false - Information level (standard logs)