The Applitools Eyes UFT/QTP SDK allows you to easily add visual checkpoints to your UFT/QTP tests. It takes care of getting screenshots of your application from the underlying UFT, sending them to the Eyes server for validation and failing the test in case differences are found.
Install the SDK
- Download the latest SDK of Applitools Eyes for and extract it into a folder of your choice.
Note: The above link points to a directory that includes the latest versions of the SDK. Once there, click on the verion you would like, which will download the file locally.
For On-Premise customers only: if your Eyes server version is less than 10.8, please download the SDK from here
Associate the Eyes.qfl function library located in the extracted folder with your test in
File > Settings > Resources > +.
If you want Eyes to be included in all tests, make sure to check
Set As Default
Run your first test
Applitools Eyes reports differences by comparing screenshots of your application with baseline images that define the expected appearance of the application at each step of the test. By default, the Eyes SDK detects the environment in which the application is running (namely, the operating system, the type of browser and its viewport size) and compares the screenshots against baseline images that are specific to that environment. The first time you run a test in a given environment, its screenshots will be automatically saved as its baseline. Starting from the second run onward, you always have a baseline to compare against.
The test below is a simple program that visually validates the Hello World web-page at https://applitools.com/helloworld. It consists of two visual checkpoints, each validating the entire application window. The first time you run this test a new baseline will be created, and subsequent test runs will be compared to this baseline. If any screenshot mismatch its baseline image in a perceptible way,
$eyes.close() will throw a
DiffsFoundException which includes a URL that points to a detailed report where you can see the detected differences and take appropriate actions such as reporting bugs, updating the baseline and more.
Before running the test, make sure to set the API key that identifies your account in the environment variable
APPLITOOLS_API_KEY or directly assign it to the
eyes.api_key property. You can find your API key under the user menu located at the right hand side of the test manager toolbar. If you don't yet have an account create it now to obtain your key.
' Make sure to include 'Eyes.qfl' via File -> Settings... -> Resources
' This is your api key, make sure you use it in all your tests.
eyes.ApiKey = Environment.Value("APPLITOOLS_API_KEY")
' Test setup - You should have 'Applitools' browser object in your objects repository
Set testBrowser = Browser("Applitools")
eyes.SetBaselineInfoFromBrowser testBrowser, 1200, 800
' Start visual UI testing - Open eyes test
eyes.Open "Hello World!", "My first web UFT test"
' Visual checkpoint #1
eyes.CheckObject testBrowser, "Hello!"
' Visual checkpoint #2
eyes.CheckObject testBrowser, "Click!"
' End visual UI testing. Validate visual correctness.
If Not eyesReport.IsPassed Then
If eyesReport.IsNew Then
Reporter.ReportEvent micFail, eyesReport.TestName, "New test inserted, See " & eyesReport.Url & " for details."
Reporter.ReportEvent micFail, eyesReport.TestName, "See " & eyesReport.Url & " for details."
Analyze your test results
Congratulations! You've successfully run your first visual UI test with Applitools Eyes! A detailed report is ready for your inspection at the Applitools Eyes test manager. Watch this 5 minute video to get acquainted with the test manager and to learn the basics of baseline maintenance.
Login to Applitools and analyze the results.
Don't suffer in silence! Let us help you. Please reach out to us to get your project working.
Taking the next steps with Applitools
Congratulations on completing this quickstart! There's still so much to learn about visual testing with Applitools, but you're off to a great start.
Resources for next steps:
- 🤖 Learning how visual testing works
- ↔️ Setting match levels for visual checkpoints
- 💥 Troubleshooting common issues
- 🐞 Reporting bugs
- 🗺 Detailed overview of visual testing with Applitools