API Docs for: 0.9.1
Show:

JenkinsSauceLabsReporter Class

Constructor

JenkinsSauceLabsReporter

()

Methods

complete

()

Reporting is completed

console

(
  • id
  • msgType
  • msg
)

Sends data to stdout

Parameters:

getConfiguration

() Object

Gets the configuration supplied

Returns:

getContainer

() ReportContainer

Gets the container

Returns:

getJobName

() String

Gets the job-name, binding the name to the session

It tries to get it from a couple different places:

  • itemData of the root as "jobName"
  • reporter configuration as "jobName"
  • environment variables with format "APP_NAME (#BUILD_NUMBER)"

Returns:

getOptions

() Object

Gets the options

Returns:

getOutput

() String

Gets the collected output

Returns:

getPath

() String

Output path

Returns:

getType

() String

Gets the type of reporter

Returns:

initialize

()

Initializes the instance

itemData

(
  • id
  • json
)

Called when any item has custom data

Parameters:

itemMessage

(
  • id
  • message
)

Called when any item has a custom message

Parameters:

output

(
  • data
)

Outputs data to stdout

Parameters:

shouldOutput

() Boolean

Should the reporter output the data?

Returns:

shouldShowProgress

() Boolean

Should the reporter show progress?

Returns:

start

()

Called when reporting starts

stop

()

Called when reporting stops

suiteEnd

(
  • id
)

Called when suite ends

Parameters:

suiteStart

(
  • id
  • parentId
  • suiteName
)

Called when suite starts

Parameters:

testError

(
  • id
  • [message]
  • [reason]
)

Called when test has an error

Parameters:

testFailed

(
  • id
  • [message]
  • [reason]
)

Called when test fails

Parameters:

testIncomplete

(
  • id
)

Called when test is incomplete

Parameters:

testPassed

(
  • id
)

Called when test has passed

Parameters:

testSkipped

(
  • id
  • [reason]
)

Called when test is skipped

Parameters:

testStart

(
  • id
  • parentId
  • testName
)

Called when test starts

Parameters:

testUndefined

(
  • id
)

Called when test is undefined

Parameters:

toString

() String

Exports data to a string

Returns:

useColor

() Boolean

Should reporter use color?

Returns:

write

()

Writes the data into an output file