Installation

Install the npm package

npm install --save-dev @orangebeard-io/javascript-client

Build from source

npm run build

Make sure to have typescript installed.

Configuration

Usually, the client is used from a listener that connects the client to a test tool. Listeners can provide their own OrangebeardParameters object.
If no configuration object is provided, the client will try to auto-configure in the following ways:

orangebeard.json

Look for a config file named orangebeard.json in the current working directory or higher in the hierarchy (it will scan all the way up to /). The json file is expected to contain an OrangebeardParameters object:

{
   "endpoint": "https://my.orangebeard.app",
   "token": "xxxxxxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx",
   "project": "my-project",
   "testset": "Test set name",
   "description": "Test run description",
   "attributes": [
   	{
   		"key": "Key 1",
   		"value": "Some value"
   	},
   	{
   		"value": "Tag value"
   	}
   ]
}

Environment variables

The auto config will scan for environment variables:

ORANGEBEARD_ENDPOINT=https://company.orangebeard.app
ORANGEBEARD_TOKEN=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
ORANGEBEARD_PROJECT=piet_personal
ORANGEBEARD_TESTSET=piet_TEST_EXAMPLE
ORANGEBEARD_DESCRIPTION=My awesome testrun
ORANGEBEARD_ATTRIBUTES=key:value; value;

Note that if auto configuration is used and a value is present in both orangebeard.json and in the environment settings, the environment setting will take precedence.