JenkinsSauceLabsReporter Class

Extends AbstractReporter

Defined in: lib/reporter/jenkinsSauceLabs.js:7

Constructor

`JenkinsSauceLabsReporter`

()

Defined in lib/reporter/jenkinsSauceLabs.js:7

Index
Methods

Item Index

Methods

complete
console
getConfiguration
getContainer
getJobName
getOptions
getOutput
getPath
getType
initialize
itemData
itemMessage
output
shouldOutput
shouldShowProgress
start
stop
suiteEnd
suiteStart
testError
testFailed
testIncomplete
testPassed
testSkipped
testStart
testUndefined
toString
useColor
write

Methods

`complete`

()

Inherited from AbstractReporter: lib/abstractReporter.js:190

Reporting is completed

`console`

(

id
msgType
msg

)

Inherited from AbstractReporter: lib/abstractReporter.js:130

Sends data to stdout

Parameters:

id String
msgType String
msg String

`getConfiguration`

() Object

Inherited from AbstractReporter: lib/abstractReporter.js:69

Gets the configuration supplied

Returns:

Object:

`getContainer`

() ReportContainer

Inherited from AbstractReporter: lib/abstractReporter.js:79

Gets the container

Returns:

ReportContainer:

`getJobName`

() String

Defined in lib/reporter/jenkinsSauceLabs.js:69

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:

String:

`getOptions`

() Object

Inherited from AbstractReporter: lib/abstractReporter.js:49

Gets the options

Returns:

Object:

`getOutput`

() String

Inherited from AbstractReporter: lib/abstractReporter.js:335

Gets the collected output

Returns:

String:

`getPath`

() String

Inherited from AbstractReporter: lib/abstractReporter.js:89

Output path

Returns:

String:

`getType`

() String

Inherited from AbstractReporter: lib/abstractReporter.js:59

Gets the type of reporter

Returns:

String:

`initialize`

()

Inherited from AbstractReporter but overwritten in lib/reporter/jenkinsSauceLabs.js:17

Initializes the instance

`itemData`

(

id
json

)

Inherited from AbstractReporter: lib/abstractReporter.js:233

Called when any item has custom data

Parameters:

id String
json String

JSON-data

`itemMessage`

(

id
message

)

Inherited from AbstractReporter: lib/abstractReporter.js:244

Called when any item has a custom message

Parameters:

id String
message String

`output`

(

data

)

Inherited from AbstractReporter: lib/abstractReporter.js:160

Outputs data to stdout

Parameters:

data String

`shouldOutput`

() Boolean

Inherited from AbstractReporter: lib/abstractReporter.js:109

Should the reporter output the data?

Returns:

Boolean:

`shouldShowProgress`

() Boolean

Inherited from AbstractReporter: lib/abstractReporter.js:119

Should the reporter show progress?

Returns:

Boolean:

`start`

()

Inherited from AbstractReporter: lib/abstractReporter.js:171

Called when reporting starts

`stop`

()

Inherited from AbstractReporter but overwritten in lib/reporter/jenkinsSauceLabs.js:103

Called when reporting stops

`suiteEnd`

(

id

)

Inherited from AbstractReporter: lib/abstractReporter.js:222

Called when suite ends

Parameters:

id String

`suiteStart`

(

id
parentId
suiteName

)

Inherited from AbstractReporter: lib/abstractReporter.js:210

Called when suite starts

Parameters:

id String
parentId String
suiteName String

`testError`

(

id
[message]
[reason]

)

Inherited from AbstractReporter: lib/abstractReporter.js:281

Called when test has an error

Parameters:

id String
[message] String optional
[reason] String optional

`testFailed`

(

id
[message]
[reason]

)

Inherited from AbstractReporter: lib/abstractReporter.js:269

Called when test fails

Parameters:

id String
[message] String optional
[reason] String optional

`testIncomplete`

(

id

)

Inherited from AbstractReporter: lib/abstractReporter.js:324

Called when test is incomplete

Parameters:

id String

`testPassed`

(

id

)

Inherited from AbstractReporter: lib/abstractReporter.js:293

Called when test has passed

Parameters:

id String

`testSkipped`

(

id
[reason]

)

Inherited from AbstractReporter: lib/abstractReporter.js:313

Called when test is skipped

Parameters:

id String
[reason] String optional

`testStart`

(

id
parentId
testName

)

Inherited from AbstractReporter: lib/abstractReporter.js:256

Called when test starts

Parameters:

id String
parentId String
testName String

`testUndefined`

(

id

)

Inherited from AbstractReporter: lib/abstractReporter.js:303

Called when test is undefined

Parameters:

id String

`toString`

() String

Inherited from AbstractReporter: lib/abstractReporter.js:379

Exports data to a string

Returns:

String:

`useColor`

() Boolean

Inherited from AbstractReporter: lib/abstractReporter.js:99

Should reporter use color?

Returns:

Boolean:

`write`

()

Inherited from AbstractReporter: lib/abstractReporter.js:389

Writes the data into an output file

APIs

JenkinsSauceLabsReporter Class

Constructor