Skip to content
gregpabian edited this page Sep 4, 2014 · 6 revisions

Dashboard

dashboard:register

Triggers when a dashboard connects to Bender's server.

Params:

  • String socketId - ID of the dashboard's socket e.g. MYz2wlBEHH46vKJYAAAC

dashboard:disconnect

Triggers when a dashboard disconnects from Bender's server.

Params:

  • String socketId - ID of the dashboard's socket e.g. MYz2wlBEHH46vKJYAAAC

Client

client:register

Triggers when a client(browser) connects to Bender server.

Params:

  • Object client - client details
  • String client.id - ID of the client e.g. 82b3810b-d80e-49bb-834e-354aab53b33a
  • String client.ua - client's User Agent e.g. Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36
  • String client.addr - client's address e.g. 192.168.1.5:1030

client:afterRegister

Triggers after registering a client on the server.

Params:

  • Object client - client details
  • String client.id - ID of the client e.g. 82b3810b-d80e-49bb-834e-354aab53b33a
  • String client.ua - client's User Agent e.g. Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36
  • String client.browser - name of client browser, e.g. chrome
  • Number client.version - client browser version, e.g. 37
  • String client.addr - client's address e.g. 192.168.1.5:1030
  • Boolean client.ready - client's readiness, if true it means the client is currently performing some tests

client:run

Triggers when a task for a client is available.

Params:

  • String clientId - ID of a client
  • Object task - task object
  • String task.id - ID of a task
  • String task.jobId - ID of a task's job
  • String task.btId - ID of a browser task

client:getTask

Triggers when a task for a client is needed - e.g. after a client registers, completes a task, a job is created or changed.

Params:

  • Object client - client object, the same as in client:afterRegister event

client:change

Triggers when a property ready of a client(browser) changes.

Params:

  • Object client - client details
  • String client.id - client's ID e.g. 82b3810b-d80e-49bb-834e-354aab53b33a
  • String client.ua - client's User Agent e.g. Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.153 Safari/537.36
  • String client.addr - client's address e.g. 192.168.1.5:1030
  • String client.browser - client's browser name e.g. chrome
  • String client.version - client's browser major version e.g. 35
  • Boolean client.ready - client's ready state

client:result

Triggers when a client completes a single test/spec(in Jasmine).

Params:

  • Object result - test result object
  • Object result.client - client data, same as in the client:change event
  • String result.name - name of a test e.g. test foo bar
  • String result.module - name of test's parent, could be a QUnit module's name, Jamsine's describe name or just an ID of a test file e.g. tests/test/1
  • Boolean result.success - test success flag
  • Number result.duration - test duration, in milliseconds
  • Boolean result.ignored - ignored test flag
  • String result.error - test error message, if any, otherwise null

client:complete

Triggers when a client completes a whole test file.

Params:

  • Object result - test result object
  • Object result.client - client object, same as in the client:change event
  • String result.btId - ID of a browser's task, used by the database e.g. Z3kaJUnrLT3RAcvP
  • String result.jobId - ID of a job, used by the database e.g. 9wEVoMWRKAXwJe9C
  • Boolean result.success - test success flag
  • Number result.duration - test duration, in milliseconds
  • Boolean result.ignored - ignored test flag
  • Array result.results - array of results of every test/spec in the file (a single result look similar to client:result event's data)

client:error

Triggers when an error occurs on a client's side.

Params:

  • String message - Error message

client:log

Triggers when a client logs a message.

Params:

  • String message - Log message

client:disconnect

Triggers when a client disconnect's from the server.

Params:

  • String id - ID of a client that disconnected

Browsers

browsers:change

Triggers when the list of browsers changes i.e. when a client connects to/disconnects from the server.

Params:

  • Array browsers - array of browsers
  • Object browser - browser family object
  • String browser.id - browser's ID, taken from browsers array in bender.js configuration file e.g. Chrome
  • String browser.name - browser's name, e.g. chrome
  • String browser.version - browser's major version, e.g. 35
  • Array browser.clients - array of clients matching this browser, objects in this array are similar to client:change event's data

Job

job:start

Triggers when a job is created.

Params:

  • Object job - job object
  • Array job.browsers - array of job's browsers
  • Boolean job.coverage - flag telling if the code coverage report is available for this job
  • Number job.created - job creation timestamp
  • String job.description - job description
  • Array job.filter - list of filters used to create this job
  • Boolean job.snapshot - flag telling if a code snapshot was taken for this job
  • Boolean job.done - flag telling if a job is done
  • String job._id - ID of a job

job:remove

Triggers when a job is deleted.

Params:

  • String jobId - deleted job ID

job:change

Triggers when a job is edited.

Params:

  • Object job - job object, same as in job:start event

job:update

Triggers when a job's changes, i.e. a test from this job finishes.

Params:

  • String id - ID of a job

job:complete

Triggers when all the tasks for this job are completed.

Params:

  • Object job - job object, same as in job:start event
  • Number status - job status, on of the statuses defined in bender.jobs.STATUS enum

Clone this wiki locally