Applitools SDKs provide advanced functionality and numerous of useful features, however - you can get a lot of coverage simply by using the basic functionality with the REST API, and gradually add advanced functionalities if and when it is needed.
EndSession
Notes:
When starting a test, the parameters passed to the StartNewSession command determine the baseline used for the visual validations. As a default, the baseline is uniquely determined by the combination of:
An Applitools test is composed of 3 main parts:
- Starting the test: this is the StartNewSession section in the API documentation (in the SDKs this is done in the eyes.open() command).
- Visual validation checkpoints (i.e. the test's "steps"): this is the MatchExpectedOutput section in the API documentation (in the SDKs this command usually translates to checkWindow).
- Ending the test: this is the EndSession section in the API documentation (in the SDKs this command translates to close).
Following are a few updates to the API guide on the commands mentioned above:
- Each call (i.e., StartNewSession, MatchExpectedOutput, and EndSession) should have a query parameter named "accessKey" and its value should be your Applitools' run-key (you receive it upon registration).
- Authorization header is not mandatory in these these three commands.
Clarification for the specific commands:
StartNewSession
- "agentId" is just a string to identify what type of client is connecting. You can use your domain name + a version number you can increment (i.e., il.ibm.com/VERSION_NUMER).
- You should use 'strict' as the default match level.
- In the environment part set the hostOS to iOS VER (e.g., "iOS 9"), and the hostApp to your application name.
EndSession
- "isAborted" should generally be false. It should only be true if you want to tell Applitools that you want to abort the test, instead of ending it normally (this can happen for example if you find an error in your application regardless of applitools and you just want to quit).
Notes:
When starting a test, the parameters passed to the StartNewSession command determine the baseline used for the visual validations. As a default, the baseline is uniquely determined by the combination of:
- The name of the application under test.
- The name of the test.
- The operating system on which the test is run.
- The type of browser/application under test.
- The resolution in which the test is run (display size/viewport size).
This means that, as a default, tests that run in iOS will use a different baseline than tests running in Android.