Skip to main content

Qase TestOps Robot Framework Reporter

PyPI version PyPI downloads License

Qase Robot Framework Reporter enables seamless integration between your Robot Framework tests and Qase TestOps, providing automatic test result reporting, test case management, and comprehensive test analytics.

Features

  • Link automated tests to Qase test cases by ID
  • Auto-create test cases from your test suites
  • Report test results with rich metadata (fields, parameters)
  • Automatic step reporting from keywords
  • Multi-project reporting support
  • Support for parallel execution with pabot
  • Flexible configuration (file, environment variables)

Installation

pip install qase-robotframework

Quick Start

1. Create qase.config.json in your project root:

{
  "mode": "testops",
  "testops": {
    "project": "YOUR_PROJECT_CODE",
    "api": {
      "token": "YOUR_API_TOKEN",
      "host": "qase.io"
    }
  }
}

If your workspace is on the EU cluster (you open Qase at app-eu.qase.io), set host to eu.qase.io. The default, qase.io, is the US cluster.

2. Add Qase ID to your test:

*** Test Cases ***
User can log in with valid credentials
    [Tags]    Q-1
    Open Login Page
    Enter Valid Credentials
    Verify Dashboard Is Visible

3. Run your tests:

robot --listener qase.robotframework.Listener tests/

Upgrading

For migration guides between major versions, see Upgrade Guide.

Configuration

The reporter is configured via (in order of priority):

  1. Environment variables (QASE_*, highest priority)
  2. Config file (qase.config.json)

Minimal Configuration

Option Environment Variable Description
mode QASE_MODE Set to testops to enable reporting
testops.project QASE_TESTOPS_PROJECT Your Qase project code
testops.api.token QASE_TESTOPS_API_TOKEN Your Qase API token
testops.api.host QASE_TESTOPS_API_HOST qase.io (US cluster, the default) or eu.qase.io (EU cluster). Required if your workspace is on the EU cluster

Example qase.config.json

{
  "mode": "testops",
  "fallback": "report",
  "testops": {
    "project": "YOUR_PROJECT_CODE",
    "api": {
      "token": "YOUR_API_TOKEN",
      "host": "qase.io"
    },
    "run": {
      "title": "Robot Framework Automated Run"
    },
    "batch": {
      "size": 100
    }
  },
  "report": {
    "driver": "local",
    "connection": {
      "local": {
        "path": "./build/qase-report",
        "format": "json"
      }
    }
  }
}

Full configuration reference: See qase-python-commons for all available options including logging, status mapping, execution plans, and more.

Usage

Associate your tests with Qase test cases using the Q-{ID} tag:

*** Test Cases ***
User Registration
    [Tags]    Q-1
    Open Registration Page
    Fill Registration Form
    Submit Form
    Verify Registration Success

User Login
    [Tags]    Q-2    Q-3
    Open Login Page
    Enter Credentials
    Click Login Button

Add Metadata

Enhance your tests with fields using the qase.fields tag:

*** Test Cases ***
Critical Purchase Flow
    [Tags]    Q-1    qase.fields:{"severity":"critical","priority":"high","layer":"e2e"}
    [Documentation]    Verify user can complete a purchase
    Add Item To Cart
    Proceed To Checkout
    Complete Payment

Add Parameters

Report specific variables as parameters using the qase.params tag:

*** Variables ***
${USERNAME}    testuser
${PASSWORD}    testpass

*** Test Cases ***
Login Test
    [Tags]    Q-1    qase.params:[USERNAME, PASSWORD]
    Login With Credentials    ${USERNAME}    ${PASSWORD}
    Verify Login Success

Ignore Tests

Exclude specific tests from Qase reporting:

*** Test Cases ***
Work In Progress
    [Tags]    qase.ignore
    Log    This test is not reported to Qase

Test Result Statuses

Robot Framework Result Qase Status
PASS passed
FAIL (AssertionError) failed
FAIL (other exception) invalid
SKIP skipped

For detailed usage examples, see the Usage Guide.

Running Tests

Basic Execution

robot --listener qase.robotframework.Listener tests/

With Environment Variables

export QASE_MODE=testops
export QASE_TESTOPS_PROJECT=PROJ
export QASE_TESTOPS_API_TOKEN=your_token
export QASE_TESTOPS_API_HOST=qase.io  # eu.qase.io for the EU cluster
robot --listener qase.robotframework.Listener tests/

With Robot Variables

robot --listener qase.robotframework.Listener \
    --variable QASE_TESTOPS_PROJECT:PROJ \
    --variable QASE_TESTOPS_API_TOKEN:your_token \
    --variable QASE_TESTOPS_API_HOST:qase.io \
    tests/

Parallel Execution with Pabot

pabot --listener qase.robotframework.Listener tests/

Requirements

  • Python >= 3.9
  • robotframework >= 5.0.0

Documentation

Guide Description
Usage Guide Complete usage reference with all tags and options
Multi-Project Support Reporting to multiple Qase projects
Upgrade Guide Migration guide for breaking changes

Examples

See the examples directory for complete working examples.

License

Apache License 2.0. See LICENSE for details.

Metadata

Release files for qase-robotframework 7.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qase-robotframework 7.0.1
File Size Uploaded Provenance Actions
qase_robotframework-7.0.1.tar.gz 24.4 kB Without provenance Details for qase_robotframework-7.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for qase-robotframework 7.0.1
File Interpreter ABI Platform Actions
qase_robotframework-7.0.1-py3-none-any.whl Python 3 none any Details for qase_robotframework-7.0.1-py3-none-any.whl

Total release size: 47.0 kB

Release files / qase_robotframework-7.0.1.tar.gz

Download URL qase_robotframework-7.0.1.tar.gz
Size 24.4 kB
Tags Source
SHA-256 checksum
How to use checksums
df6ab3496741146d8be862f26992c514e4e2a1d01ac6d356cced2966d3faf17f
BLAKE2b-256 checksum
How to use checksums
1f3c2ee2bab2594f1eb3df4536147a47a094930dab6af3407ea9b42fc7551ee6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / qase_robotframework-7.0.1-py3-none-any.whl

Download URL qase_robotframework-7.0.1-py3-none-any.whl
Size 22.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e6be2d9fc3fc27296d9e9b33aba1babe79dfc956ca5a677449f440d947c8e6a
BLAKE2b-256 checksum
How to use checksums
210313ccd63855d2a1645151895ea900724f9274b4c781fce97a464557f0e24d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for qase-robotframework 7.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

7.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page