Orangebeard.io Python Client

Orangebeard Python client for Python based Orangebeard Listeners.

Orangebeard | Installation

Installation

Install the pip package

Note: this client should be used as a dependency in listener projects

pip install orangebeard-client

CLI

The python client comes with a simple command line utility orangebeard-cli. This utility can be used to start and finish test runs outside a listener's lifecycle. Mainly useful to report parrallel executions to the same Orangebeard test run.

Usage:

usage: Orangebeard CommandLine Utility [-h] [-e ENDPOINT] [-t ACCESSTOKEN] [-p PROJECT] -x {start,finish} [-s TESTSET] [-d DESCRIPTION] [-id TESTRUNUUID]

CLI to start or finish a test run

options:
  -h, --help            show this help message and exit
  -e ENDPOINT, --endpoint ENDPOINT
                        Your Orangebeard endpoint
  -t ACCESSTOKEN, --accessToken ACCESSTOKEN
                        Your Orangebeard Access Token
  -p PROJECT, --project PROJECT
                        Orangebeard Project Name
  -x {start,finish}, --cmd {start,finish}
                        Command to execute
  -s TESTSET, --testset TESTSET
                        The testset name
  -d DESCRIPTION, --description DESCRIPTION
                        The test run description (optional)
  -a ATTRIBUTES, --attributes ATTRIBUTES
                        Test run attributes (optional)
  -id TESTRUNUUID, --testRunUuid TESTRUNUUID
                        The UUID of the test run to finish, required for finish

Example (Robotframework using pabot):

#!/bin/bash
testrunUuid=$(orangebeard-cli -x start -a "myTag;commitUrl:https://github.com/prj")
pabot --listener orangebeard_robotframework.listener  --variable orangebeard_testrun:"$testrunUuid"  .
orangebeard-cli -x finish -id $testrunUuid