open method

Class: EyesPlatform: Selenium 3Language: JavaScript SDK:

Call this method to start a test, before calling any of the check methods.

Syntax


let result = await eyes.open(driver, appName, testName, viewportSize);

Parameters

appName
Type:string
The application name. This may be any string. You can set the application name for all tests using the method(s) . If you do so, then set this parameter to a value of null to indicate that the configuration default should be used.
testName
Type:string
The name of the test. This name must be unique within the scope of the application name. It may be any string.
viewportSize
Type:{width: number, height: number}

The size of the viewport

The size of the viewport passed as an object.

The size of the viewport passed as an object {'width':, 'height':}

Defines the viewport size of the browser that will be set before the start of the test. If this parameter is not provided then the viewport size will be based on the current browser window size. See Using viewports in Eyes for more details.

driver
Type:WebDriver
The web driver.

Return value

Type: Promise<WebDriver>
The returned web driver is a clone of the driver passed as a parameter. It is recomended that you use the web driver object returned by this method in all further calls to the web driver. This allows Eyes to record these interactions and play them back in the Eyes Test Manager.

Remarks

After making a call to this method, you must eventually terminate the test by calling Eyes.close (in case of a normal completion) or Eyes.abortIfNotClosed (in case of an aborted test). If you want to run another test, then it is recomended to do this with a newly created Eyes instance to avoid side effects. However, in principle, it is legal to call Eyes.open again to start a new test on the same Eyes instance.