The information in this topic may be out of date. The current SDK reference guide has moved here.

TestResults class

Platform: Selenium 3Language: JavaScript SDK:
Encapsulates the results of a visual test, including summary information and checkpoint-specific details. An object of this class is returned by the close method upon test completion.

Require statement

const {TestResults} = require('const EyesSDK = require('eyes.selenium'))');
	

Properties

appUrlsType:{batch: session}
Use this property to retrieve an object with a set of URLs that you can use to access the Test Manager in a browser, preloaded with the results of this test.
appnameType:string
Use this property to retrieve the application name.
batchIdType:string
Use this property to retrieve the unique batch ID of the test batch.
batchNameType:string
Use this property to retrieve the batch name.
branchNameType:string
Use this property to retrieve the branch name of the test.
durationType:number
Use this property to retrieve the amount of time the test ran.
hostAppType:string
Use this property to retrieve the host application (browser) property of the test.
hostDisplaySizeType:{width:number; height:number}
Use this property to retrieve the viewport size used to identify the baseline.
hostOSType:string
Use this property to retrieve the host OS property of the test.
isAbortedType:boolean
Use this property to retrieve whether the test was aborted or not
isDifferentType:boolean
Indicates that at least one step was missing, or a mismatch.
isnewType:boolean
Use this property to retrieve whether this is a new test or not (i.e. no existing baseline was found for this test).
matchesType:number
Use this property to retrieve the number of test steps where the checkpoint image matched the baseline image.
mismatchesType:number
Use this property to retrieve the number of test steps where the checkpoint image did not match the baseline image. This includes new steps (i.e. steps where a baseline corresponding to the checkpoint was not found). It does not include missing steps. You can obtain this value using the missing property.
missingType:number
Use this property to retrieve the number of test steps where an image corresponding to the checkpoint image was not found in the baseline.
nameType:string
Use this property to retrieve the name of the test.
startedAtType:string
Use this property to retrieve the date and time the test started.
statusType:string
Use this property to retrieve a status that represents the results of the test.
stepsType:number
Use this property to retrieve the total number of steps in the result.
stepsInfoType:StepInfo[]
Use this property to retrieve an array of objects with information on all steps in the test.