IBM/otc-saucelabs-broker

Name: otc-saucelabs-broker

Owner: International Business Machines

Description: OTC Sauce Labs Broker

Created: 2016-06-04 18:09:35.0

Updated: 2017-02-25 05:23:05.0

Pushed: 2017-02-25 05:23:03.0

Homepage: null

Size: 182

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

NAME

OTC Saucelabs Broker

This broker is an implementation of an OTC Service Broker.

Logging

Logging is handled using log4js.

To configure the logging levels and output location, modify the config/log4js.json file.

USAGE

# Implemented Endpoints
GET /version
    Version info including build time and git info
GET /status
    Up status (server up and database read check)
PUT /saucelabs-broker/api/v1/service_instances/:sid
    Creates or updates the service instance.
PATCH /saucelabs-broker/api/v1/service_instances/:sid
    Patches the service instance.
PUT /saucelabs-broker/api/v1/service_instances/:sid/toolchains/:tid
    Binds the service instance to a toolchain.
DELETE /saucelabs-broker/api/v1/service_instances/:sid
    Deletes the service instance.
DELETE /saucelabs-broker/api/v1/service_instances/:sid/toolchains
    Removes all toolchains associated with the service instance.
DELETE /saucelabs-broker/api/v1/service_instances/:sid/toolchains/:tid
    Removes the toolchain associated with the service instance.

LOCAL USAGE

# Grab the code.

git clone https://github.ibm.com/org-ids/otc-saucelabs-broker.git
cd otc-saucelabs-broker

On the command line, run:

export OTC_API_BROKER_SECRET="<otc api broker secret>"
export CLOUDANT_URL="<cloudant url name without protocol>"
export CLOUDANT_DATABASE="<a database name>"
export CLOUDANT_PASSWORD="<password>"
export CLOUDANT_USERNAME="<account name>"
export LOCAL_KEY="<the key used to encrypt/decrypt the saucelabs key>" (not used)

For Qradar, set the following:
export log4js_syslog_appender_enabled=true
export log4js_syslog_appender_host=syslog.prd.ccs.ibmcloud.com
export log4js_syslog_appender_port=6514
export log4js_syslog_appender_product=otc-saucelabs-broker-local
export log4js_syslog_appender_certificateBase64=<CERT AS B64>
export log4js_syslog_appender_privateKeyBase64=<PRIVATE KEY AS B64>
export log4js_syslog_appender_caBase64=<CA AS B64>

For Logmet appender, set the following:
export log4js_logmet_enabled=true
export log4js_logmet_component=otc-saucelabs-broker-local
export log4js_logmet_logging_token=<ENV LOGGING TOKEN>
export log4js_logmet_space_id=<ENV SPACE ID> (YS1 dev is ed841776-9394-4b51-a86c-72ddc5529e05)
export log4js_logmet_logging_host=<ENV LOGGING HOST> (YS1 dev is logs.stage1.opvis.bluemix.net)
export log4js_logmet_logging_port=9091

You also need to set an IDS user (for the private modules)
export IDS_USER=<IDS USER>
export IDS_PASSWORD=<IDS PASSWORD>

Install the module dependencies by running ./bulld/build.sh
Start the node app by running npm start.

RUNNING TESTS

build_info.json

This file is required for test. You can create it by running ./version.sh or
saving the json on the /version route on the server you want to test

Install the dev dependencies

Running up tests

On the command line, run:

node test/up

Running API test

New shell, on the command line, run:
export TEST_URL="<base url to the broker>" (local example http://localhost:6001)
export SAUCELABS_USERNAME="<your saucelabs username>"
export SAUCELABS_KEY="<your saucelabs key>"
export ORGANIZATION_GUID="<a valid org id for TEST_USER>"
export TEST_USER="<test username>"
export TEST_PASSWORD="<test username password>"

From the repository top dir, run

node test/api

and for some reporting:

node test/api.js | node_modules/tap-xunit/bin/tap-xunit > report.xml